/**
 * Copyright (c) 2010 by Kevin Bierhoff.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the names of the authors nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.syper.anno;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
 * @author Kevin Bierhoff
 * @since Jan 17, 2010
 *
 */
@Target({ ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE, ElementType.FIELD })
public @interface Imm {

	/** 
	 * Indicates whether this permission is borrowed (the default)
	 * or captured.
	 * @return <code>true</code> if this permission is borrowed, 
	 * <code>false</code> if it is captured.
	 */
	boolean borrowed() default true;

	/**
	 * If {@link #borrowed()} is {@code false} this flag indicates whether
	 * the permission is released with the annotated method's result.
	 * This works for constructors too.
	 * This is <strong>not applicable to fields</strong>.
	 * This is ignored when {@link #borrowed()} is {@code true}.
	 * @return {@code true} if this permission is released with the method
	 * result, {@code false} otherwise.
	 */
	boolean released() default false;

	/**
	 * Array of permission specifiers for each array dimension
	 * @return
	 */
	String[] elems() default {};
}
